Child Protection
Domain Message Specification

Version: 1.0; Status: RC5 Patch D

CP-ISNHSQuery Tabular View

QUPC_RM000006GB01
CP-ISQueryStub
The CP-ISQueryStub class is a dummy class which is used to connect to the HL7 query control act wrappers.
Used by:
[1..1] [M] cP-ISNHSQuery (CP-ISNHSQuery)
A link to the query.
CP-ISNHSQuery
This class is the control act for the query payload.
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="CACT" }

Model Attribute Description

The HL7 attribute classCode describes this class as a control act.

Implementation in XML Instance

The XML attribute classCode is fixed to "CACT".

Schema Constraint

  • classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode describes this class as a control act event.

Implementation in XML Instance

The XML attribute moodCode is fixed to "EVN".

Schema Constraint

  • The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] code (CV { CNE:CP-ISMessageType } )
{ Fixed="03" }

Model Attribute Description

The HL7 attribute code uses a code from the CP-ISMessageType vocabulary to describe this control act as a CP-IS message.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value(CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain a fixed value of "03"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.470"
  • The XML attribute displayName shall contain a fixed value of "CP-IS NHS Query".

Schema Constraint

  • The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance.
  • The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance.
  • The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 attribute effectiveTime is used to define the time the person made the CP-IS query.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time the query was made using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify the CP-IS query.

Implementation in XML

The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:

  • The XML attribute root shall contain the DCE UUID of the query.
[1..1] [M] queryByParameter (QueryByParameter)
A link to the query parameter.
[1..1] [M] author

This participant class is the person who authored (queried) the CP-IS system.
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode describes this class as an author participation.

Implementation in XML Instance

The XML attribute typeCode is fixed to "AUT".

Schema Constraint

  • The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] contentId (II) { "NPFIT-100037#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (AuthorChoice)
A link to the choice of authors.
QueryByParameter
This class is used to link all the parameters used in the query together.
Used by: CP-ISNHSQuery
[1..1] [M] person.NHSnumber (Person.NHSnumber)
This class is used to hold a query parameter of the NHS number.
Person.NHSnumber
This class is used to hold a query parameter of the NHS number.
Used by: QueryByParameter
[1..1] [M] semanticsText (ST)
{ Fixed="Person.NHSnumber" }
Model Attribute Description

The HL7 attribute semanticsText is used to hold a literal text string identifying the parameter item.

Implementation in XML Instance

The XML element semanticsText shall contain a fixed value of "Person.NHSnumber".

Schema Constraint

  • The attribute semanticsText is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] value (II)

Model Attribute Description

The HL7 attribute value is used to hold the NHS number of the patient that is a parameter in the query. This parameter is mandatory and the NHS number must be a valid verified nhs number.

Implementation in XML Instance

The XML element value should be populated as below:

  • The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.4.1"
  • The XML attribute extension shall contain the 10 digit NHS number.

Schema Constraint

The attribute root is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[0..1] [M] accessEventType (accessEventType)
This class is used to hold a parameter of the accessEventType.
accessEventType
This class is used to hold a parameter of the accessEventType.
Used by: QueryByParameter
[1..1] [M] semanticsText (ST)
{ Fixed="accessEventType" }
Model Attribute Description

The HL7 attribute semanticsText is used to hold a literal text string identifying the parameter item.

Implementation in XML Instance

The XML element semanticsText shall contain a fixed value of "accessEventType".

Schema Constraint

  • The attribute semanticsText is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] value (Boolean)

Model Attribute Description

The HL7 attribute value is used to hold the isUnscheduledAccessEvent flag. When set to "true" the CP-IS Query originated from unscheduled care, when set to "false" the CP-IS Query originated from scheduled care. If the accessEventType is omitted, it is assumed that the CP-IS Query originated from unscheduled care.

Implementation in XML Instance

The XML element value should be populated as below:

  • The XML attribute isUnscheduledAccessEvent shall contain "true" or "false"
AuthorChoice
A choice of author templates.
Used by: CP-ISNHSQuery
[1..1] : Template1